-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docusaurus v3 upgrade #503
Conversation
✅ Deploy Preview for nebari-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Can I get some help debugging the failure in the CI build? The error is |
Checked Netlify per @krassowski suggestions, and we do configure the Node version there. Updated to use 18.x now: Re-built the site, and seems to be working on Netlify now. The preview above also works. I am not sure why the GitHub CI is still red and not updating. @kcpevey I'll push an empty commit to this PR to re-trigger CI. Please let me know if you'd like me to refrain from pushing up to your branch in the future. :) |
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
I'll take all the help I can get - I always welcome collaboration :) Thank you so much for looking into this @pavithraes ! And thanks for the assistance on finding the solution @krassowski ! |
This is now ready for review. One thing that I do need resolved is the icon admonition (discussed in the description). If we're fine to remove, then its done. If it needs to stay, then I'll need help re-implementing it in a way that docusaurus v3 likes. |
I removed the icon admonition as I think its no longer necessary. This is ready for review. |
I'll have to do conflict resolution again whenever we are close to merging. |
@viniciusdc Now that blocking PR has been merged, I'll resolve conflicts and get things working again. I'll ping you when its ready for final review. |
@viniciusdc this is ready for a final look! |
@kcpevey I've noticed from the current built version of this PR, that some of the admonition colors and codeblocks styles are not showing up correctly, is this intended? before:current PR build: |
Hmmm. I'll have to look more closely. I did make a change to admonitions that may be having an effect here. |
@viniciusdc The styling that was previously working for the admonitions is no longer being used. All of the admonitions now are using the css rules that start with There is also a comment in So at this point, everything in |
Thats okay thank you for having a look into it @kcpevey -- wonder if this might be due to docssaurus-sass plug-in |
Its possible? We brought up the plan to open an issue to resolve the admonition styling in a separate issue/PR and go ahead and merge this one since its so big. No one disagreed, so @viniciusdc I think we're good to go ahead and merge? |
This PR upgrades the docs to Docusaurus V3. There are some breaking changes and this PR includes all the required changes to make the docs build again after the upgrade.
Some things to note:
icon
admonition we had in the docusaurus config is no longer allowed. I had a hard time understanding the admonitions, but it seems like theicon
admonition was being customized in/src/theme/components/admonitions.scss
and the examples for V3 are all using js. Those are outside of my skillset so if we want to keep that, I'll need some help with that bit.package.json
andyarn.lock
. I think I did that right?Reference Issues or PRs
Resolves #395
What does this implement/fix?
Put a
x
in the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1
or#
in markdown).Non-text content
Any other comments?